.. _cmmCfgGetSpeedPattern:

cmmCfgGetSpeedPattern
=========================
-------------------------

SYNOPSYS
`````````````

.. code-block:: none
   
    VT_I4 cmmCfgGetSpeedPattern(
        [in] VT_I4 Axis, [out] VT_PI4 SpeedMode, [out] VT_PR8 WorkSpeed, [out] VT_PR8 Accel, [out] VT_PR8 Decel
        )


DESCRIPTION
`````````````

- 지정한 축에 대해 속도 모드, 작업속도 및 가속 및 감속도를 설정할 수 있으며, 설정된 값을 읽을 수 있습니다.
  이 속도는 각 모션제어의 기준 속도로 설정되며, 해당 기준속도에 비율로 각 모션제어를 수행할 수 있습니다. 설정된
  기준속도는 단축 제어의 경우 실제 모션 속도 지령 함수인 cmmSxSetSpeedRatio 와 같은 함수를 통해 그 비율로 모션
  제어의 속도를 결정할 수 있습니다.


PARAMETER
```````````

- Axis: 축번호. 축번호는 상수값으로 [cmX1] 부터 0 번째 축을 기준 축으로 임의의 축을 설정할 수 있습니다.

\

- SpeedMode : cmmCfgGetSpeedPattern 함수의 인자이며, 속도모드의 반환값입니다.

.. csv-table::
    :widths: 15 85
    :header-rows: 1
    :stub-columns: 0

    value, Meaning
    0 또는 cmSMODE_C, CONSTANT 속도모드 => 가감속을 수행하지 않습니다.
    1 또는 cmSMODE_T, TRAPEZOIDAL 속도모드 => 사다리꼴 가감속을 수행합니다.
    2 또는 cmSMODe_S, S-CURVE 속도모드 => S-CURVE 가감속을 수행합니다.


가감속 패턴은 S-Curve 형과 선형 가감속 형, 가감속이 없는 형태가 가능합니다.

- WorkSpeed : cmmCfgGetSpeedPattern 함수의 인자이며, 작업 속도를 반환합니다.

\

- Accel : cmmCfgGetSpeedPattern 함수의 인자이며, 가속도를 반환합니다.

\

- Decel : cmmCfgGetSpeedPattern 함수의 인자이며, 감속도를 반환합니다.


RETURN VALUE
`````````````

+--------------+----------------+
| Value        | Meaning        |
+==============+================+
| 음수         | 수행 실패      |
+--------------+----------------+
| cmERR_NONE   | 수행 성공      |
+--------------+----------------+


REFERENCE
```````````

- 한번 설정한 속도설정은 변경하기 전까지 계속해서 적용됩니다. 따라서 속도를 변경할 필요가 없는 경우에는 이송명령을 수행할 때마다 속도설정을 해줄 필요는 없습니다.

\

- 속도와 가/감속도의 단위는 cmmCfgSetUnitSpeed() 함수에 의해 결정됩니다. 

.. image:: ../../Image/4장_6.jpg

.. image:: ../../Image/4장_7.jpg


EXAMPLE
`````````

- cmmCfgGetSpeedPAttern을 참조해주세요.

.. seealso:: :ref:`cmmSxSetSpeedRatio`, :ref:`cmmCfgSetSpeedPattern`